<?php ob_start('ob_gzhandler') ?>
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <!--
        /**
        * o------------------------------------------------------------------------------o
        * | This file is part of the RGraph package - you can learn more at:             |
        * |                                                                              |
        * |                          http://www.rgraph.net                               |
        * |                                                                              |
        * | This package is licensed under the RGraph license. For all kinds of business |
        * | purposes there is a small one-time licensing fee to pay and for non          |
        * | commercial  purposes it is free to use. You can read the full license here:  |
        * |                                                                              |
        * |                      http://www.rgraph.net/LICENSE.txt                       |
        * o------------------------------------------------------------------------------o
        */
    -->
    <title>RGraph: HTML5 canvas graph library - funnel chart documentation</title>
    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
    <link rel="icon" type="image/png" href="/favicon.png">
</head>
<body>
    <div id="breadcrumb">
        <a href="../index.html">RGraph: HTML5 canvas graph library</a>
        >
        <a href="index.html">Documentation</a>
        >
        Funnel chart
    </div>

    <h1>RGraph: HTML5 canvas graph library - Funnel chart documentation</h1>

    <script>
        if (document.all) {
            document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer does not natively support the HTML5 canvas tag yet, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul></div>');
        }
    </script>

    <p>
        This is a funnel chart. It can be used to illustrate stages of a sales or order fulfillment process, and in doing so highlight any bottlenecks
        or steps where large amounts of customers are lost.
    </p>
    
    <p> 
        The example file is <a href="../examples/funnel.html">here</a>.
    </p> 
    
    <pre class="code">
&lt;script&gt;
    window.onload = function ()
    {
        var funnel = new RGraph.Funnel('funnel1', [100,45,45,26,21,5]);
        funnel.Set('chart.text.boxed', false);
        funnel.Set('chart.title', 'Leads through to sales');
        funnel.Set('chart.labels', ['A', 'B', 'C', 'D', 'E', 'F']);
        funnel.Set('chart.shadow', true);
        funnel.Draw();
    }
&lt;/script&gt;
</pre>


    <h2>Available properties</h2>
    
    <p>
        You can use these properties to control how the Funnel chart appears. You can set them by using the Set() method. Eg:
    </p>
    
    <p>
        <b>myFunnel.Set('name', 'value');</b>
    </p>


    <!--
        <PROPERTIES>
            chart.gutter :: The gutter of the chart. This is the whitespace area around the chart.<br /><i>Default: 25</i>
            chart.colors :: These are the colors used for each segment.<br /><i>Default: ['red', 'green', 'gray', 'blue', 'black', 'white']</i>
            chart.labels :: An array of the labels to be used on the graph. <br /><i>Default: An empty array</i>
            chart.text.font :: The font used to render the text.<br /><i>Default: Verdana</i>
            chart.text.color :: The color of the labels. <br /><i>Default: black</i>
            chart.text.size :: The size (in points) of the labels. <br /><i>Default: 10</i>
            chart.text.boxed :: Whether the text is contained within a white bounding box. In some cases this can help readability.<br /><i>Default: true</i>
            chart.text.halign :: The horizontal alignment of the text. Can be <i>center</i> or <i>left</i>.<br /><i>Default: left</i>
            chart.title :: The title of the graph, if any. <br /><i>Default: null</i>
            chart.title.vpos :: This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i>
            chart.title.color :: The color of the title.<br /> <i>Default: black</i>
            chart.shadow :: Whether a drop shadow is applied to the Funnel chart. The funnel is the first to use the canvas shadow API, and as such they won't be supported on all browsers. Currently only Safari 4+ (possibly earlier versions too), Firefox 3.5+ and Chrome 2+ support canvas shadows.<br /><i>Default: false</i>
            chart.shadow.color :: The color of the drop shadow.<br /><i>Default: #666</i>
            chart.shadow.blur :: The severity of the shadow blurring effect.<br /><i>Default: 3</i>
            chart.shadow.offsetx :: The X offset of the shadow.<br /><i>Default: 3</i>
            chart.shadow.offsety :: The Y offset of the shadow.<br /><i>Default: 3</i>
            chart.contextmenu :: An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i>
            chart.key :: An array of informational texts to be used as the key<br /><i>Default: [] (An empty array)</i>
            chart.key.position :: This determines where the key is drawn. It can be "graph" or "gutter".<br /><i>Default: graph</i>
            chart.key.background :: This is the colour used for the background of the key.<br /><i>Default: #fff</i>
            chart.key.shadow :: Whether a small drop shadow is applied to the key.<br /><i>Default: false</i>
            chart.tooltips :: An array of tooltips for the Funnel chart segments.<br /><i>Default: null</i>
            chart.tooltip.effect :: The animated effect that tooltips use - <i>fade</i> or <i>expand</i><br /><i>Default: fade</i>
            chart.annotatable :: Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i>
            chart.annotate.color :: If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i>
            chart.zoom.mode :: Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i>
            chart.zoom.factor :: This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i>
            chart.zoom.fade.in :: Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.fade.out :: Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i>
            chart.zoom.hdir :: The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i>
            chart.zoom.vdir :: The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i>
            chart.zoom.delay :: The delay (in milliseconds) between frames.<br /><i>Default: 50</i>
            chart.zoom.frames :: The number of frames in the zoom animation.<br /><i>Default: 10</i>
            chart.zoom.shadow :: Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i>
            chart.zoom.thumbnail.width :: When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.thumbnail.height :: When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i>
            chart.zoom.background :: Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i>
        </PROPERTIES>
    -->

    <!-- DOCS -->

    <table border="0" id="docs">
        <tr>
            <th><a name="chart.gutter"></a>chart.gutter</th>
            <td>The gutter of the chart. This is the whitespace area around the chart.<br /><i>Default: 25</i></td>
            <th><a name="chart.colors"></a>chart.colors</th>
            <td>These are the colors used for each segment.<br /><i>Default: ['red', 'green', 'gray', 'blue', 'black', 'white']</i></td>
        </tr>
        <tr>
            <th><a name="chart.labels"></a>chart.labels</th>
            <td>An array of the labels to be used on the graph. <br /><i>Default: An empty array</i></td>
            <th><a name="chart.text.font"></a>chart.text.font</th>
            <td>The font used to render the text.<br /><i>Default: Verdana</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.color"></a>chart.text.color</th>
            <td>The color of the labels. <br /><i>Default: black</i></td>
            <th><a name="chart.text.size"></a>chart.text.size</th>
            <td>The size (in points) of the labels. <br /><i>Default: 10</i></td>
        </tr>
        <tr>
            <th><a name="chart.text.boxed"></a>chart.text.boxed</th>
            <td>Whether the text is contained within a white bounding box. In some cases this can help readability.<br /><i>Default: true</i></td>
            <th><a name="chart.text.halign"></a>chart.text.halign</th>
            <td>The horizontal alignment of the text. Can be <i>center</i> or <i>left</i>.<br /><i>Default: left</i></td>
        </tr>
        <tr>
            <th><a name="chart.title"></a>chart.title</th>
            <td>The title of the graph, if any. <br /><i>Default: null</i></td>
            <th><a name="chart.title.vpos"></a>chart.title.vpos</th>
            <td>This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i></td>
        </tr>
        <tr>
            <th><a name="chart.title.color"></a>chart.title.color</th>
            <td>The color of the title.<br /> <i>Default: black</i></td>
            <th><a name="chart.shadow"></a>chart.shadow</th>
            <td>Whether a drop shadow is applied to the Funnel chart. The funnel is the first to use the canvas shadow API, and as such they won't be supported on all browsers. Currently only Safari 4+ (possibly earlier versions too), Firefox 3.5+ and Chrome 2+ support canvas shadows.<br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.color"></a>chart.shadow.color</th>
            <td>The color of the drop shadow.<br /><i>Default: #666</i></td>
            <th><a name="chart.shadow.blur"></a>chart.shadow.blur</th>
            <td>The severity of the shadow blurring effect.<br /><i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.shadow.offsetx"></a>chart.shadow.offsetx</th>
            <td>The X offset of the shadow.<br /><i>Default: 3</i></td>
            <th><a name="chart.shadow.offsety"></a>chart.shadow.offsety</th>
            <td>The Y offset of the shadow.<br /><i>Default: 3</i></td>
        </tr>
        <tr>
            <th><a name="chart.contextmenu"></a>chart.contextmenu</th>
            <td>An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i></td>
            <th><a name="chart.key"></a>chart.key</th>
            <td>An array of informational texts to be used as the key<br /><i>Default: [] (An empty array)</i></td>
        </tr>
        <tr>
            <th><a name="chart.key.position"></a>chart.key.position</th>
            <td>This determines where the key is drawn. It can be "graph" or "gutter".<br /><i>Default: graph</i></td>
            <th><a name="chart.key.background"></a>chart.key.background</th>
            <td>This is the colour used for the background of the key.<br /><i>Default: #fff</i></td>
        </tr>
        <tr>
            <th><a name="chart.key.shadow"></a>chart.key.shadow</th>
            <td>Whether a small drop shadow is applied to the key.<br /><i>Default: false</i></td>
            <th><a name="chart.tooltips"></a>chart.tooltips</th>
            <td>An array of tooltips for the Funnel chart segments.<br /><i>Default: null</i></td>
        </tr>
        <tr>
            <th><a name="chart.tooltip.effect"></a>chart.tooltip.effect</th>
            <td>The animated effect that tooltips use - <i>fade</i> or <i>expand</i><br /><i>Default: fade</i></td>
            <th><a name="chart.annotatable"></a>chart.annotatable</th>
            <td>Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i></td>
        </tr>
        <tr>
            <th><a name="chart.annotate.color"></a>chart.annotate.color</th>
            <td>If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i></td>
            <th><a name="chart.zoom.mode"></a>chart.zoom.mode</th>
            <td>Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.factor"></a>chart.zoom.factor</th>
            <td>This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i></td>
            <th><a name="chart.zoom.fade.in"></a>chart.zoom.fade.in</th>
            <td>Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.fade.out"></a>chart.zoom.fade.out</th>
            <td>Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i></td>
            <th><a name="chart.zoom.hdir"></a>chart.zoom.hdir</th>
            <td>The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.vdir"></a>chart.zoom.vdir</th>
            <td>The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i></td>
            <th><a name="chart.zoom.delay"></a>chart.zoom.delay</th>
            <td>The delay (in milliseconds) between frames.<br /><i>Default: 50</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.frames"></a>chart.zoom.frames</th>
            <td>The number of frames in the zoom animation.<br /><i>Default: 10</i></td>
            <th><a name="chart.zoom.shadow"></a>chart.zoom.shadow</th>
            <td>Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.thumbnail.width"></a>chart.zoom.thumbnail.width</th>
            <td>When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
            <th><a name="chart.zoom.thumbnail.height"></a>chart.zoom.thumbnail.height</th>
            <td>When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i></td>
        </tr>
        <tr>
            <th><a name="chart.zoom.background"></a>chart.zoom.background</th>
            <td>Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i></td>
        </tr>
    </table><br /><br />

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</body>
</html>